<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../print.css" type="text/css" media="print">
<meta content="CursorBookmark,mx.collections.CursorBookmark,CURRENT,FIRST,LAST,value,getViewIndex" name="keywords">
<title>mx.collections.CursorBookmark</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'CursorBookmark - Zentrum virtUOS: virtPresenter';
				var baseRef = '../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">virtPresenter AsDoc</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../all-classes.html')" href="../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../all-classes.html')" href="../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../index-list.html')" href="../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../index.html?mx/collections/CursorBookmark.html&amp;mx/collections/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Class&nbsp;CursorBookmark</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#propertySummary">Properties</a>&nbsp;| <a href="#methodSummary">Methods</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class CursorBookmark"); titleBar_setSubNav(false,true,false,false,false,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">mx.collections</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Class</td><td class="classSignature">public class CursorBookmark</td>
</tr>
</table>
<p></p>
  Encapsulates the positional aspects of a cursor in an 
  <code>ICollectionView</code>.  Bookmarks are used to return a cursor to 
  an absolute position within the <code>ICollectionView</code>.
   <p></p>
<p>
<span class="classHeaderTableLabel">See also</span>
</p>
<div class="seeAlso">
<a href="../collections/IViewCursor.html#bookmark" target="">mx.collections.IViewCursor.bookmark</a>
<br>
<a href="../collections/IViewCursor.html#seek()" target="">mx.collections.IViewCursor.seek()</a>
</div>
<br>
<hr>
</div>
<a name="propertySummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Properties</div>
<table id="summaryTableProperty" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#CURRENT">CURRENT</a> : <a href="../collections/CursorBookmark.html">CursorBookmark</a>
<div class="summaryTableDescription">[static][read-only]
      A bookmark representing the current item for the <code>IViewCursor</code> in
      an <code>ICollectionView</code>.</div>
</td><td class="summaryTableOwnerCol">CursorBookmark</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#FIRST">FIRST</a> : <a href="../collections/CursorBookmark.html">CursorBookmark</a>
<div class="summaryTableDescription">[static][read-only]
      A bookmark for the first item in an <code>ICollectionView</code>.</div>
</td><td class="summaryTableOwnerCol">CursorBookmark</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#LAST">LAST</a> : <a href="../collections/CursorBookmark.html">CursorBookmark</a>
<div class="summaryTableDescription">[static][read-only]
      A bookmark for the last item in an <code>ICollectionView</code>.</div>
</td><td class="summaryTableOwnerCol">CursorBookmark</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#value">value</a> : Object<div class="summaryTableDescription">[read-only]
      The underlying marker representation of the bookmark.</div>
</td><td class="summaryTableOwnerCol">CursorBookmark</td>
</tr>
</table>
</div>
<a name="methodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Methods</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#CursorBookmark()">CursorBookmark</a>(value:Object)</div>
<div class="summaryTableDescription">
      Creates a new instance of a bookmark with the specified value.</div>
</td><td class="summaryTableOwnerCol">CursorBookmark</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getViewIndex()">getViewIndex</a>():int</div>
<div class="summaryTableDescription">
      Get the approximate index of the item represented by this bookmark
      in its view.</div>
</td><td class="summaryTableOwnerCol">CursorBookmark</td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="propertyDetail"></a>
<div class="detailSectionHeader">Property detail</div>
<a name="CURRENT"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">CURRENT</td><td class="detailHeaderType">property</td>
</tr>
</table>
<div class="detailBody">
<code>CURRENT:<a href="../collections/CursorBookmark.html">CursorBookmark</a></code>&nbsp;&nbsp;[read-only]<p>
      A bookmark representing the current item for the <code>IViewCursor</code> in
      an <code>ICollectionView</code>.
           </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public static function get CURRENT():<a href="../collections/CursorBookmark.html">CursorBookmark</a></code>
<br>
</div>
<a name="FIRST"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">FIRST</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>FIRST:<a href="../collections/CursorBookmark.html">CursorBookmark</a></code>&nbsp;&nbsp;[read-only]<p>
      A bookmark for the first item in an <code>ICollectionView</code>.
           </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public static function get FIRST():<a href="../collections/CursorBookmark.html">CursorBookmark</a></code>
<br>
</div>
<a name="LAST"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">LAST</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>LAST:<a href="../collections/CursorBookmark.html">CursorBookmark</a></code>&nbsp;&nbsp;[read-only]<p>
      A bookmark for the last item in an <code>ICollectionView</code>.
     If the view has no items, the cursor is at this bookmark.
           </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public static function get LAST():<a href="../collections/CursorBookmark.html">CursorBookmark</a></code>
<br>
</div>
<a name="value"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">value</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>value:Object</code>&nbsp;&nbsp;[read-only]<p>
      The underlying marker representation of the bookmark.
      This value is generally understood only by the <code>IViewCursor</code>
      or <code>ICollectionView</code> implementation.
     </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get value():Object</code>
<br>
</div>
<a name="constructorDetail"></a>
<div class="detailSectionHeader">Constructor detail</div>
<a name="CursorBookmark()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">CursorBookmark</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>
</tr>
</table>
<div class="detailBody">
<code>public function CursorBookmark(value:Object)</code><p>
      Creates a new instance of a bookmark with the specified value.
           </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">value</span>:Object</code> &mdash; The value of this bookmark.
     </td>
</tr>
</table>
</div>
<a name="methodDetail"></a>
<div class="detailSectionHeader">Method detail</div>
<a name="getViewIndex()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getViewIndex</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
</tr>
</table>
<div class="detailBody">
<code>public function getViewIndex():int</code><p>
      Get the approximate index of the item represented by this bookmark
      in its view.  If the item has been paged out this method could throw an 
      ItemPendingError.  If the item is not in the current view -1 is 
      returned.  This method also returns -1 if index-based location is not
      possible.
     </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>int</code></td>
</tr>
</table>
</div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright"> 
</center>
</div>
</body>
</html>
<!-- -->
